org.eclipse.vtp.framework.interactions.voice.vxml
Class AudioOutput

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.support.Widget
      org.eclipse.vtp.framework.interactions.voice.vxml.Output
          org.eclipse.vtp.framework.interactions.voice.vxml.OutputSet
              org.eclipse.vtp.framework.interactions.voice.vxml.AudioOutput

All Implemented Interfaces:

VXMLConstants

public class AudioOutput
extends OutputSet

The AudioOutput class represents the <audio> VXML element and specifies the location of an audio file to be played to the caller. An AudioOutput can only be contained by the Prompt and Choice elements. All other output must be some combination of BasicOutput or its subclasses.

Version:

2.0

Author:

Trip Gilman, Lonnie Pryor

Field Summary

protected java.lang.String

audioFileURI The URI of the audio file to play to the caller.

Fields inherited from interface org.eclipse.vtp.framework.interactions.voice.vxml.VXMLConstants

EMPTY, FILE_EXT_GSL, FILLED_MODE_ALL, FILLED_MODE_ANY, GRAMMAR_MODE_DTMF, GRAMMAR_MODE_VOICE, METHOD_GET, METHOD_POST, MIME_TYPE_GSL, MIME_TYPE_SRGS, NAME_APPLICATION, NAME_ASSIGN, NAME_AUDIO, NAME_BARGEIN, NAME_BEEP, NAME_BLOCK, NAME_BRIDGE, NAME_CATCH, NAME_CHOICE, NAME_COMPLETETIMEOUT, NAME_COND, NAME_CONFIDENCELEVEL, NAME_COUNT, NAME_DEST, NAME_DISCONNECT, NAME_DTMF, NAME_DTMFTERM, NAME_ELSE, NAME_ELSEIF, NAME_ENCTYPE, NAME_ENUMERATE, NAME_ERROR, NAME_EVENT, NAME_EVENTEXPR, NAME_EXIT, NAME_EXPR, NAME_FIELD, NAME_FILLED, NAME_FINALSILENCE, NAME_FORM, NAME_GOTO, NAME_GRAMMAR, NAME_ID, NAME_IF, NAME_INCOMPLETETIMEOUT, NAME_INPUTMODES, NAME_INTERDIGITTIMEOUT, NAME_ITEM, NAME_MAXNBEST, NAME_MAXSPEECHTIMEOUT, NAME_MAXTIME, NAME_MENU, NAME_METHOD, NAME_MODE, NAME_NAME, NAME_NAMELIST, NAME_NEXT, NAME_NOINPUT, NAME_NOMATCH, NAME_ONE_OF, NAME_OPTION, NAME_PARAM, NAME_PROMPT, NAME_PROPERTY, NAME_RECORD, NAME_REPEAT, NAME_REPROMPT, NAME_RETURN, NAME_ROOT, NAME_RULE, NAME_SCOPE, NAME_SCRIPT, NAME_SENSITIVITY, NAME_SPEEDVSACCURACY, NAME_SRC, NAME_SUBDIALOG, NAME_SUBMIT, NAME_TERMCHAR, NAME_TERMTIMEOUT, NAME_THROW, NAME_TIMEOUT, NAME_TRANSFER, NAME_TYPE, NAME_VALUE, NAME_VAR, NAME_VERSION, NAME_VXML, NAMESPACE_URI_VXML, QNAME_XML_LANG, SCOPE_DIALOG, SCOPE_DOCUMENT, TYPE_CDATA, VERSION_2_0

Constructor Summary

AudioOutput(java.lang.String audioFileURI)
Creates a new instance of AudioOutput with the specified audio file URI.

Method Summary

java.lang.String	getAudioFileURI() Returns the URI of the audio file to be played to the caller.
void	setAudioFileURI(java.lang.String audioFileURI) Sets the URI of the audio file to be played to the caller.
protected void	writeAttributes(org.xml.sax.helpers.AttributesImpl attributes) Write the attribute members of this condition to the supplied set.
void	writeWidget(org.xml.sax.ContentHandler outputHandler) Writes the content of this widget to an XML content handler.

Methods inherited from class org.eclipse.vtp.framework.interactions.voice.vxml.OutputSet

addOutput, getOutputs, removeOutput, writeOutputs

Methods inherited from class org.eclipse.vtp.framework.interactions.core.support.Widget

toString, writeAttribute, writeChildren, writeChildren, writeWidget, writeWidget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

audioFileURI

protected java.lang.String audioFileURI

The URI of the audio file to play to the caller.

Constructor Detail

AudioOutput

public AudioOutput(java.lang.String audioFileURI)
            throws java.lang.IllegalArgumentException,
                   java.lang.NullPointerException

Creates a new instance of AudioOutput with the specified audio file URI. The URI passed in may be a string literal or an expression that will evaluate to the desired string literal.

Parameters:

audioFileURI - The URI of the audio file to play to the caller.

Throws:

java.lang.IllegalArgumentException - If the supplied URI is empty.

java.lang.NullPointerException - If the supplied URI is null.

Method Detail

getAudioFileURI

public java.lang.String getAudioFileURI()

Returns the URI of the audio file to be played to the caller.

Returns:

The URI of the audio file.

setAudioFileURI

public void setAudioFileURI(java.lang.String audioFileURI)
                     throws java.lang.IllegalArgumentException,
                            java.lang.NullPointerException

Sets the URI of the audio file to be played to the caller.

Parameters:

audioFileURI - The new URI of the audio file.

Throws:

java.lang.IllegalArgumentException - If the supplied URI is empty.

java.lang.NullPointerException - If the supplied URI is null.

writeWidget

public void writeWidget(org.xml.sax.ContentHandler outputHandler)
                 throws java.lang.NullPointerException,
                        org.xml.sax.SAXException

Description copied from class: Widget

Writes the content of this widget to an XML content handler.

Overrides:

writeWidget in class OutputSet

Parameters:

outputHandler - The handler to write this widget to.

Throws:

java.lang.NullPointerException - If the supplied content handler is null.

org.xml.sax.SAXException - If the writing of this widget fails.

writeAttributes

protected void writeAttributes(org.xml.sax.helpers.AttributesImpl attributes)

Write the attribute members of this condition to the supplied set.

Parameters:

attributes - The attribute set to write to.

Throws:

java.lang.NullPointerException - If the supplied attribute set is null.